home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d7 / getfil16.arc / GETFILE.DOC < prev    next >
Text File  |  1991-06-03  |  5KB  |  111 lines
  1. GETFILE v1.6  (91 06 03)  Documentation       (c) Copyright 1991 by Roy Pereira
  2. -------------------------------------------------------------------------------
  3.  
  4. Ok, I've given in to peer pressure and written some documentation for this
  5. thing.  GETFILE is a small door that uses the special features of PCBoard 14.5a
  6. to include the file descriptions along with the rest of your batch download.
  7. This is a feature I think, that all bbs and protocol developers should think
  8. about incorporating.
  9.  
  10.  
  11. THE PROBLEM:
  12.   You download quite regularly from bulletin boards, but when you finnally
  13. take a look at your directory, you forget what the hell you downloaded!
  14.  
  15.  
  16. THE SOLUTION:
  17.   You have two options:  Either spend 'x' amount of time downloading the
  18. entire file list from the bulletin board, or use GETFILE.
  19.  
  20.  
  21. WHAT GETFILE DOES:
  22.   GetFile loads up your pcboard.dat file and gets the location of your dir.lst
  23. file. It then opens it up and finds out what your directory file are.  Now it
  24. goes through them and copies the file descriptions for the files you have
  25. specified. It saves these file descriptions to a plain text file.  It then save
  26. the following to PCBSTUFF.KBD: "DB descfile.txt file1 file2 file3 ..." where
  27. descfile.txt is the name that you specified and file1, file2, file3... are the
  28. names of the files you wish to download.  This has the effect of stuffing this
  29. string into the keyboard as if you would have typed it. Ces't tous! (That's it)
  30.  
  31.  
  32. USAGE:
  33.   GETFILE <pcboard.dat> <descfile.txt> <file1> [file2 [file3...]]
  34.  
  35. eg.  GETFILE %PCBDAT% C:\PCB\BLT\FLDESC%NODE%.TXT %PCBDOOR%
  36.  
  37.  
  38. EXPLANATION OF USAGE:
  39.   The %PCBDAT% parameter is the environmental variable set by PCBoard that
  40. is the path and name of your current PCBOARD.DAT file.
  41.   Starting with v1.3, the <descfile.txt> does not need to have the node
  42. number in it.  GetFile will automatically use the node number as a prefix
  43. to this filename. eg.  If <descfile.txt> equals "C:\PCB\BLT\IMPORT.ME" and
  44. the user is on node 14, then the file "14IMPORT.ME" in the "C:\PCB\BLT"
  45. directory would be created.
  46.  
  47. NOTE: This file HAS to reside in one of your download paths!  You can later
  48.       delete these file description files in your event.
  49.   The %PCBDOOR% paramter is the variable set by PCBoard that has the parameters
  50. that were typed after the door name while the user was in PCBoard.
  51.   Eg.  GETFILE PCBFILES PKUNZIP.EXE
  52.    PCBDOOR would be "PCBFILES PKUNZIP.EXE"
  53.  
  54. NOTE:  PCBFILES would be looked up as PCBFILES.ZIP if ZIP was your default
  55.        extension as set by in PBCSETUP.  If you default extension was ARC,
  56.        then it would be PCBFILE.ARC instead.
  57.  
  58.  
  59. GetFile can handle up to 99 files. And starting with v1.5, GetFile can handle
  60. wildcards in its file names.
  61.  
  62.  eg.  GETFILE PCB* BLT*.*
  63.  
  64.   This will find all files in the conference that are like "PCB?????.ZIP" or
  65. "BLT?????.???".
  66.  
  67.  
  68. SYNTAX IN PCBOARD:
  69.   To make this door small, there is no code to ask the user for the file names.
  70. This would have made the door a lot bigger since I would have needed to
  71. incorporate communications code to access the COM ports.  Instead I opted for
  72. a simpler method.  For GETFILE to operate properly the user must type in the
  73. filenames on the same line as GETFILE.  Just typing in GETFILE by itself will
  74. download an empty file description file.
  75.  
  76.  
  77. SETING UP:
  78.   I recommend shelling to GETFILE from PCBoard by using these parameters in
  79. your door.lst file:
  80.  
  81.     File Name   Sec  Login   USER SYS   DOOR SYS    Shell
  82.     GETFILE     20   N       N          N           Y
  83.  
  84.  
  85. DISCLAIMER:
  86.   Offiously, I will not be responsible for damages that you may inflict on
  87. any computer equipment (hardware or software) just because you used my
  88. software.  GETFILE is being distributed as freeware, but is copyrighted by me!
  89. Please don't sell it or include it in a package that will then be sold.  The
  90. source code is available to anyone who wants it by contacting me.
  91.  
  92.  
  93. AUTHOR:
  94.   I can be reached at Saltair, the PCBoard support BBS, as "CANADIAN INT.".
  95.  
  96.   Roy Pereira (819) 994-3857
  97.   CIDA bbs    (819) 953-8208/8207  14400 Dual HST/Ultra 96 (DataPac soon)
  98.   Saltair bbs (801) 261-8976       9600 HST
  99.  
  100.  
  101. APPOLOGIES:
  102.   I do appologize to anyone who was frustrated by GETFILE without any
  103. documentation.  I hope this helps.  If this document isn't clear enough though,
  104. I will answer your questions at the above places.
  105.  
  106. HISTORY:
  107.   1.6  -  91 06 03 - Now also looks at the public upload DIR file.
  108.   1.5  -  91 05 24 - Added support for wildcards.
  109.   1.4  -  91  ?  ? - Uses the default extension if needed.
  110.   1.3  -  91  ?  ? - I don't remember!
  111.